home *** CD-ROM | disk | FTP | other *** search
/ Suzy B Software 2 / Suzy B Software CD-ROM 2 (1994).iso / christin / concrd22 / spirited.doc < prev    next >
Encoding:
Text File  |  1995-05-02  |  20.1 KB  |  249 lines

  1.                                 SpiritEd
  2.                              (Version  1.1)
  3.  
  4.                            INSTRUCTION MANUAL
  5.  
  6.  
  7. About SpiritEd...
  8.  
  9. SpiritEd is a simple GEM-based text editor in the form of a desk 
  10. accessory. It is written to provide an ability to take notes and prepare 
  11. lessons from within SpiritWare's Bible concordance program. However, you 
  12. may find it useful in a wide variety of applications.
  13.  
  14. Like all SpiritWare programs, SpiritEd is designed to be easy to use. If 
  15. you have ever used a Macintosh, you already know how to use SpiritEd. Its 
  16. use of the mouse, menus, and keyboard conforms as closely as possible to 
  17. Macintosh user interface guidelines.
  18.  
  19. It is important to bear in mind that SpiritEd is a text editor and not a 
  20. word processor. As a text editor, it provides basic editing capabilities 
  21. including cutting, copying, pasting, searching and replacing. It also has 
  22. an undo function that allows you to cancel the last operation that was 
  23. performed. It does not provide the formatting capabilities of a word 
  24. processor. However, text entered into SpiritEd can be saved to a file and 
  25. later imported into a full-featured word processor for formatting.
  26.  
  27. About SpiritWare...
  28.  
  29. SpiritWare is produced by servants of our Lord Jesus Christ at Fifteenth 
  30. Avenue Bible Church in Seattle, Washington for the edification of His 
  31. body. While SpiritWare is copyrighted, permission is granted for unlimited 
  32. noncommercial copying and distribution of SpiritWare programs. This 
  33. program can and should be freely distributed.
  34.  
  35. Installing SpiritEd
  36.  
  37. To install SpiritEd, simply copy SPIRITED.ACC from the distribution disk 
  38. to the main directory of your boot disk or partition. SpiritEd will be 
  39. available from the Desk Accessory menu of the desktop or any GEM-based 
  40. program the next time you boot up. It is important to remember that if you 
  41. use the standard GEM desktop, you can only have six desk accessories 
  42. loaded at one time. If you already have six and you want to add SpiritEd, 
  43. you will have to remove one of the others.
  44.  
  45. Opening SpiritEd
  46.  
  47. SpiritEd can only be accessed from the GEM desktop or GEM applications. To 
  48. open SpiritEd, select SpiritEd from the desk accessory menu. The SpiritEd 
  49. window will appear on the screen.
  50.  
  51. Closing SpiritEd
  52.  
  53. SpiritEd never really goes away, it is always hanging around in memory. 
  54. You can make its window disappear by clicking on the go away box in the 
  55. upper left corner of the window (or by pressing Control-Q).
  56.  
  57. Moving the SpiritEd Window
  58.  
  59. Like most GEM windows, the SpiritEd window can be moved to any position on 
  60. the screen by dragging the Move Bar.
  61.  
  62. Sizing the SpiritEd Window
  63.  
  64. The SpiritEd window can be resized either by clicking on the Full Box in 
  65. the upper right corner of the window, or by dragging the Size Box in the 
  66. lower right corner of the window. The Full Box allows you to easily toggle 
  67. between a full-screen window and a smaller sized window.
  68.  
  69. Using the SpiritEd Menu Bar
  70.  
  71. Since desk accessories do not have access to the main menu bar, the menu 
  72. bar for SpiritEd appears in its window. This menu bar can be accessed any 
  73. time the SpiritEd window is active. Please note that when SpiritEd is 
  74. active, the main menu bar becomes disabled. To reactivate the main menu 
  75. bar you must click on one of the main application's windows. When the main 
  76. menu bar is active, the SpiritEd window and menu bar are inactive.
  77.  
  78. Like the main menu bar, SpiritEd menus drop down when the mouse pointer is 
  79. placed over them. Unlike the main menu bar, SpiritEd menus automatically 
  80. disappear when the mouse pointer is moved outside of the menu. To select a 
  81. menu item, simply click on that item. Most SpiritEd menu items have 
  82. keyboard equivalents which are shown on the right side of the menu. 
  83. Instead of using the mouse to select a command from a menu, the same 
  84. command can be invoked from the keyboard. This is done by holding down the 
  85. Control key and pressing the key indicated in the menu. For example, to 
  86. open a file from the keyboard, press the Control key and the O key at the 
  87. same time.
  88.  
  89. Opening a File
  90.  
  91. To open a file, select Open from the File menu. The Atari File Selector 
  92. box will appear, allowing you to select the file you would like to edit. 
  93. (If you don't know how to use the Atari File Selector, please refer to 
  94. your ST owner's manual.)
  95.  
  96. SpiritEd actually only opens the file long enough to copy its contents 
  97. into memory. It then closes the file. Any changes that you make to the 
  98. text only alter the copy that is in memory, not the original file that is 
  99. on disk. These changes stay in memory, even when SpiritEd is not visible 
  100. on the screen. To transfer your changes to the original file, you must 
  101. save the text (see the next section).
  102.  
  103. The fact that there are two copies of the text (a memory copy, used by 
  104. SpiritEd, and a disk copy) present at the same time can sometimes be 
  105. confusing. For example, let's say you are using SpiritEd and you open a 
  106. text file called MYFILE.TXT. After making some changes in this file, you 
  107. decide to print MYFILE.TXT from a desktop publishing program. So you close 
  108. SpiritEd, start up the desktop publishing program, and open up MYFILE.TXT. 
  109. But none of the changes you made are there! Actually they are, but they 
  110. are in SpiritEd's section of memory and not on disk. To solve this 
  111. problem, you should open SpiritEd back up, save MYFILE.TXT, and then 
  112. reopen MYFILE.TXT from the desktop publishing program. Another problem 
  113. that can arise is forgetting to save a file before turning off your 
  114. computer. Your file will be lost, since everything in memory disappears 
  115. when the computer is turned off. Also, when your computer crashes, usually 
  116. everything in memory is lost; therefore, it is wise to save the text 
  117. frequently.
  118.  
  119. Saving the Text
  120.  
  121. To permanently record the changes that have been made, the text must be 
  122. saved. When you save, the text that is being edited in memory is copied on 
  123. to your disk. To save, select Save from SpiritEd's File menu (or press 
  124. Control-S). You will be presented with Atari's File Selector. Check the 
  125. entries in the "Directory:" and "Selection:" fields; if they are correct, 
  126. press the OK button. If they are not correct, change them and the press 
  127. the OK button. (See your ST Owner's Manual for details on how to use the 
  128. File Selector).
  129.  
  130. When you use the Save command, the text is saved without carriage returns 
  131. at the end of each wrapped line. The only carriage returns that are saved 
  132. are the ones that you have actually inserted into the text. This is the 
  133. format that SpiritEd expects to find when it opens a file. However, some 
  134. word processors expect to find carriage returns at the end of each line. 
  135. To save a file in this format, use the Print command and select the Print 
  136. to File option. The file will be saved just as it would be printed, with 
  137. the left margin padded with spaces as determined by the current Printer 
  138. Left Margin setting and the width of the text limited by the current 
  139. Printer Text Width setting. (These settings are controlled through the 
  140. Options command in the SpiritWare menu.)
  141.  
  142. Viewing the Text
  143.  
  144. Like most GEM applications, you can use the Scroll Bar to view any part of 
  145. the text. The small white box within the Scroll Bar, called the Scroll 
  146. Box, indicates roughly where you are in the text with respect to the 
  147. beginning and end of the text. The Scroll Box itself can be moved by 
  148. dragging it up or down. To move to the top of the text, drag the Scroll 
  149. Box to the top of the Scroll Bar. Likewise, to go to the bottom of the 
  150. text, drag the Scroll Box down to the bottom of the Scroll Bar.
  151.  
  152. The up and down arrows in the Scroll Bar move the text up or down one line 
  153. at a time. To move the text up one full screen, click in the gray area 
  154. above the Scroll Box; click in the gray area below the Scroll Box to move 
  155. the text down one full screen. Scrolling the text one full screen at a 
  156. time can also be done from the keyboard. To move down in the text, you can 
  157. use either F1 or Control-Down Arrow (i.e., hold the Control key down and 
  158. press the Down Arrow cursor key). To move up in the text from the 
  159. keyboard, press either F2 or Control-Up Arrow.
  160.  
  161. Moving the Cursor
  162.  
  163. The cursor position is indicated by thin flashing line, called the 
  164. insertion point. The insertion point can be moved up, down, left, or right 
  165. by pressing the corresponding cursor key. In addition, you can move the 
  166. insertion point to the end of a line by holding down the Shift key and 
  167. pressing the Right Arrow cursor key. To move to the beginning of a line, 
  168. hold down the Shift key and press the Left Arrow key.
  169.  
  170. You can also position the insertion point by moving the mouse to the 
  171. desired spot and pressing the mouse button. Please note that the position 
  172. of the mouse in the text does not change when you scroll to another 
  173. section of text.
  174.  
  175. Entering Text
  176.  
  177. When you press a key, the corresponding character is inserted into the 
  178. text at the insertion point. You can use the Backspace key to erase the 
  179. character to the left of the insertion point and the Delete key to erase 
  180. the character to the right of the insertion point.
  181.  
  182. As you enter text, SpiritEd will automatically start a new line when you 
  183. reach the right-hand edge of the window. This process is called word 
  184. wrapping. Do not use the Return key in the middle of a paragraph-- let 
  185. SpiritEd wrap the line. You can use the Return key to force a carriage 
  186. return at any point in the text; a small CR symbol appears in the text 
  187. where the Return key has been pressed.
  188.  
  189. Selecting Text
  190.  
  191. When editing, it is often necessary to select a block of text. To select 
  192. text, position the mouse at the start or the end of the block, press the 
  193. left mouse button, and drag to the other end of the block. Selected text 
  194. appears white on a black background. You can also select a block of text 
  195. by "shift-clicking". This is done by positioning the insertion point at 
  196. either the start or the end of the block you would like to select. Then, 
  197. move the cursor to the other end of the block, hold down the Shift key, 
  198. and click the left mouse button. One other way to select text is to 
  199. double-click. Double-clicking on a word causes that word to become 
  200. selected.
  201.  
  202. Deleting Text
  203.  
  204. There are several ways to delete text. First, as mentioned above, when 
  205. there is no selected text, the Backspace key can be used to delete the 
  206. character on the left of the insertion point, and the Delete key can be 
  207. used to remove the character on the right. Second, one complete line of 
  208. text can be deleted placing the cursor on that line and pressing 
  209. Control-D. Third, a block of selected text can be deleted by selecting the 
  210. block (see above) and then pressing either the Backspace key or the Delete 
  211. key, or by using the Cut command from the Edit menu (see "Using the 
  212. Clipboard", below).
  213.  
  214. Replacing Text
  215.  
  216. A quick way to replace a block with new text is to select the block (see 
  217. above) and then start entering the new text. When a character is entered 
  218. while a block of text is selected, that character replaces the block, and 
  219. the insertion point is placed to the right of the character. Another way 
  220. to replace a block of selected text is to use the Paste command from the 
  221. Edit menu (see "Using the Clipboard", below) to replace the selected block 
  222. with the contents of the clipboard. Finally, words can be automatically 
  223. replaced throughout the text with the use of the Replace command (see 
  224. below).
  225.  
  226. Using the Clipboard
  227.  
  228. The clipboard is used to store a block of text. Only one block can be 
  229. stored at a time, so when a new block is put into the clipboard, the 
  230. previous one is lost. The information that is placed in the clipboard is 
  231. available to all programs that support the Atari clipboard standard. (This 
  232. includes the SpiritWare concordance program. Information can be 
  233. transferred from the concordance program to SpiritEd and from SpiritEd to 
  234. the Concordance program via the clipboard.)
  235.  
  236. The Edit commands, Cut and Copy (or Control-X and Control-C) are used to 
  237. put a block of selected text onto the clipboard. (See above for 
  238. instructions on how to select a block of text). The Cut command deletes 
  239. the block of text after it copies it to the clipboard. The Copy command 
  240. only copies the text to the clipboard.
  241.  
  242. The information on the clipboard can be inserted into the text through the 
  243. use of the Paste command (or Control-V). When the Paste command is 
  244. selected, the contents of the clipboard are inserted into the text at the 
  245. insertion point. If a block of text is selected when Paste is executed, 
  246. the contents of the clipboard replaces the selected text.
  247.  
  248. Using the Undo Command
  249.  
  250. The Undo command is used to undo the last editing operation that was 
  251. performed. For example, if you delete a block of text and then decided you 
  252. did it wrong, you can restore the block by selecting Undo in the Edit menu 
  253. or by pressing Control-Z or the Undo key. Or, if you just pasted the 
  254. clipboard contents into the text and found that you put it in the wrong 
  255. spot, you can remove it by using the Undo command.
  256.  
  257. It is important to note that the Undo command reverses the effect of the 
  258. last editing operation on the text, but does not reverse the effect of 
  259. that operation on the clipboard. If the last operation was a Cut command, 
  260. the Undo command will restore the text that was cut out, but the 
  261. information that was on the clipboard before the Cut command was issued 
  262. will not be restored.
  263.  
  264. Using the Find Command
  265.  
  266. To find a word in the text rapidly, you can use the Find command. When 
  267. Find is selected from the Search menu (or Control-F is pressed), a dialog 
  268. box appears on the screen, allowing you to enter the text string that you 
  269. want to search for. You can also select whether you want the search to be 
  270. case-sensitive, and whether you want the search to just look at whole 
  271. words.
  272.  
  273. A case-sensitive search will only find text that matches the upper and 
  274. lower case characters of the string that you entered into the dialog box. 
  275. For example, if the text string you entered was "peace", any occurrence of 
  276. the string Peace would be ignored if the search was case-sensitive, but 
  277. would be found if the search was not case-sensitive.
  278.  
  279. To make sure that you do not find places where your search string matches 
  280. just a part of a word, you can do a whole-word search. For example, if you 
  281. are searching for the word rain, and your text has the word train in it, 
  282. train will be found by the Find command unless you specify that you only 
  283. want to find the whole word rain.
  284.  
  285. The Find command starts searching from the current location of the 
  286. insertion point or from the end of the currently selected block of text. 
  287. If it reaches the end of the file before it finds the text it is looking 
  288. for, it will place an alert box on the screen, telling you that it 
  289. couldn't find the string and asking if you want to continue the search 
  290. from the beginning of the file. If it does find the string you are looking 
  291. for, it selects that text and positions it so that it can be seen on the 
  292. screen.
  293.  
  294. Once the string you are searching for has been found, you can initiate 
  295. another search by selecting the Find Again command (or by pressing 
  296. Control-A). The Find Again command assumes that you are looking for the 
  297. same text string and that you want to do the same type of search that you 
  298. did the last time.
  299.  
  300. Using the Replace Command
  301.  
  302. The Replace command can be used to find a word or character string and 
  303. replace it with another word or character string. When Replace is selected 
  304. from the Edit menu (or Control-R is pressed), a dialog box appears onto 
  305. which allows you to enter the string you want to search for and the string 
  306. you want to replace it with. Like the Find command, you can also select 
  307. whether you want to replace only whole words and whether you want the 
  308. search to be case-sensitive. (See the previous section for more 
  309. information about these two options.)
  310.  
  311. You can also select whether you want to replace every occurrence of the 
  312. word. If you choose Yes, then every time that word or character string is 
  313. found, it will be replaced. If you choose No, then each time the string is 
  314. found, you will be asked if you want to replace it. If you select Yes, the 
  315. string will be replaced and the next occurrence will be found. If you 
  316. select No, the string will be left unchanged and the search will continue 
  317. to the next occurrence of the string. If you select quit, the Replace 
  318. command will be terminated.
  319.  
  320. The Replace operation, like Find, starts at the insertion point and 
  321. continues to the end of the file. Only the last occurrence of the string 
  322. that was replaced is undoable.
  323.  
  324. Printing
  325.  
  326. You can print either the entire text, or a block of selected text by 
  327. choosing the Print command from the File menu (or by pressing Control-P). 
  328. (See above for instructions on how to select a block of text.) When 
  329. printing, the text starts at the Left Margin setting and automatically 
  330. wraps so it does not extend beyond the Text Width setting. (Left Margin 
  331. and Text Width are set with the Option command, see below.) The Print to 
  332. File option allows you to send the text to a file instead of the printer. 
  333. For more information on how to use this option, refer to the section on 
  334. saving text.
  335.  
  336. Setting Options
  337.  
  338. The Option command in the SpiritWare menu allows the user to control 
  339. several different program parameters. The user can either make temporary 
  340. changes to these options, or make them permanent so they automatically 
  341. take effect each time the system is booted up. Permanent option settings 
  342. are stored in a file called SPIRITED.OPT which is stored in the root 
  343. directory of the boot drive.
  344.  
  345. TAB SPACING - When you are entering text and you press the Tab key, 
  346. SpiritEd inserts spaces into the text to move you to the next tab stop. 
  347. The tab stops are spaced at even intervals across the screen. The Tab 
  348. Spacing option is used to set the distance between tab stops. The default 
  349. setting is two characters. [If you are going to import this text into a 
  350. word processor or desktop publishing program, you may want to insert an 
  351. actual tab, rather than spaces. This can be done by pressing Shift Tab. A 
  352. clock face will appear on the screen to indicate the presence of the tab 
  353. character and no spacing to the tab stop will occur.]
  354.  
  355. AUTO INDENT - You can have SpiritEd automatically indent the start of each 
  356. new paragraph by selecting the Auto Indent option. When this option is 
  357. selected, and you press the return key, SpiritEd checks to see how far the 
  358. previous paragraph was indented and indents the new paragraph the same 
  359. amount. To use this option you need to manually indent the first 
  360. paragraph.
  361.  
  362. SAVE BACKUP - Each time you save you use the Save command, the version of 
  363. the text that is in SpiritEd replaces the old contents of the file. You 
  364. can have the old contents automatically saved into a backup file by 
  365. selecting Save Backup. If you use the Save Backup feature, the old 
  366. contents are placed into a file with a .BAK extension whenever you use the 
  367. Save command. For example, if you are working with a file called 
  368. MYFILE.TXT, the backup file would be called MYFILE.BAK.
  369.  
  370. PRINTER LEFT MARGIN - This option allows you to control how big to the 
  371. left margin will be when text is printed. The number you enter indicates 
  372. how many spaces will be inserted at the left margin before a line of text 
  373. is printed.
  374.  
  375. PRINTER TEXT WIDTH - You can control the maximum number of characters 
  376. SpiritEd will put on a line when printing by using this option. The number 
  377. of characters you specify does not include the spaces placed at the left 
  378. margin (see above).
  379.  
  380. PRINTER LINE SPACE - This option allows you to control the number of line 
  381. feeds that will be sent to the printer at the end of each line. 
  382. Single-spacing of text is accomplished by entering 1 for this option and 
  383. double-spacing by entering 2.
  384.  
  385. MAX FILE SIZE - Use this option to control the amount of memory you want 
  386. to set aside for SpiritEd to use while editing files. The amount of memory 
  387. you should allocate depends on how much memory you have and how large the 
  388. files are that you will be editing. Since the only time SpiritEd can 
  389. allocate memory is when the computer is turned on or reset, the changes 
  390. you make in this setting willl not be effective until you restart your 
  391. computer.
  392.